Vcenter Vcha PlacementSpec

The Vcenter Vcha PlacementSpec schema contains information to describe the inventory placement of a single node of a VCHA cluster.

This schema was added in vSphere API 6.7.1.

JSON Example

{
    "name": "string",
    "folder": "string",
    "host": "string",
    "resource_pool": "string",
    "ha_network_type": "string",
    "ha_network": "string",
    "management_network_type": "string",
    "management_network": "string",
    "storage": {
        "datastore": "string"
    }
}

string

name

Required

The name of the VCHA node to be used for the virtual machine name.

This property was added in vSphere API 6.7.1.

string

folder

Required

The identifier of the folder to deploy the VCHA node to.

This property was added in vSphere API 6.7.1.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder:VCenter.

string

host

Optional

The identifier of the host to deploy the VCHA node to.

This property was added in vSphere API 6.7.1.

If missing or null, see vim.vm.RelocateSpec.host.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem:VCenter.

string

resource_pool

Optional

The identifier of the resource pool to deploy the VCHA node to.

This property was added in vSphere API 6.7.1.

If missing or null, then the active node's resource pool will be used.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool:VCenter.

string

ha_network_type

Optional

The type of the Network object used by the HA network.
If the Vcenter Vcha PlacementSpec.ha_network property is set, then the Vcenter Vcha PlacementSpec.ha_network_type field must be set.
If the Vcenter Vcha PlacementSpec.ha_network property is missing or null, then the Vcenter Vcha PlacementSpec.ha_network_type property is ignored.

For more information see: Vcenter Vcha NetworkType.

This property was added in vSphere API 6.7.1.

If missing or null and the Vcenter Vcha PlacementSpec.ha_network property is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
If missing or null and the Vcenter Vcha PlacementSpec.ha_network property is set, then an error is reported.

string

ha_network

Optional

The identifier of the Network object used for the HA network.
If the Vcenter Vcha PlacementSpec.ha_network property is set, then the {#link #haNetworkType} property must be set.
If the Vcenter Vcha PlacementSpec.ha_network property is missing or null, then the Vcenter Vcha PlacementSpec.ha_network_type property is ignored.

This property was added in vSphere API 6.7.1.

If missing or null and the Vcenter Vcha PlacementSpec.ha_network_type property is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Network:VCenter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Network:VCenter.

string

management_network_type

Optional

The type of the Network object used by the Management network.
If the Vcenter Vcha PlacementSpec.management_network property is set, then the {#link #managementNetworkType} field must be set.
If the Vcenter Vcha PlacementSpec.management_network property is missing or null, then the Vcenter Vcha PlacementSpec.management_network_type property is ignored.

For more information see: Vcenter Vcha NetworkType.

This property was added in vSphere API 6.7.1.

If missing or null and the Vcenter Vcha PlacementSpec.management_network property is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.
If missing or null and the Vcenter Vcha PlacementSpec.management_network property is set, then an error is reported.

string

management_network

Optional

The identifier of the Network object used for the Management network. If the Vcenter Vcha PlacementSpec.management_network property is set, then the Vcenter Vcha PlacementSpec.management_network_type property must be set.
If the Vcenter Vcha PlacementSpec.management_network property is missing or null, then the Vcenter Vcha PlacementSpec.management_network_type property is ignored.

This property was added in vSphere API 6.7.1.

If missing or null and the Vcenter Vcha PlacementSpec.management_network_type property is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination.

storage

Optional

The storage specification to deploy the VCHA node to.

This property was added in vSphere API 6.7.1.

If missing or null, see vim.vm.RelocateSpec.datastore.